4.2 Consultar planos de pagamento

Request

Request

query PaymentPlans {
    paymentPlans(where: { refId: {eq: "fbc2f932-89be-4dba-8c00-bd6b3e820cef"}}) {
        items {
            paymentPlanType
            financialOwnerId
            companyId
            costCenterId
            financialIntegrationId
            id
            creationDate
            active
            deleted
            billings(order: { id: ASC }) {
                pixCode
                value
                dueDate
                barcode
                billingStatus
            }
            financialOwner {
                name
                cpf
            }
        }
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	PaymentPlanFilterInput	Objeto que define os critérios de filtragem para os planos de pagamento.
order	[PaymentPlanSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto PaymentPlanFilterInput

Campo	Tipo	Descrição
active	BooleanOperationFilterInput	Status de Ativação
and	[PaymentPlanFilterInput!]	Combinação de filtros AND
apiRequestLogs	ListFilterInputTypeOfApiRequestLogFilterInput	Logs de requisições API
billings	ListFilterInputTypeOfBillingFilterInput	Dados das Cobranças
changes	ListFilterInputTypeOfLogHistoryFilterInput	Histórico de alterações
company	CompanyFilterInput	Dados da Empresa
companyId	IntOperationFilterInput	Id da Empresa
costCenter	CostCenterFilterInput	Dados do Centro de Custo
costCenterId	IntOperationFilterInput	Id do Centro de Custo
creationDate	DateTimeOperationFilterInput	Data de Criação
deductedDiscounts	ListFilterInputTypeOfDeductedDiscountFilterInput	Descontos Deduzidos
deleted	BooleanOperationFilterInput	Status de Deleção
dependent	DependentFilterInput	Dados do Dependente
dependentId	IntOperationFilterInput	Id do Dependente
description	StringOperationFilterInput	Descrição
documentFileUrl	StringOperationFilterInput	Url do arquivo pdf das cobranças
externalId	IntOperationFilterInput	Id Externo
financialIntegration	FinancialIntegrationFilterInput	Dados da Integração Financeira
financialIntegrationId	IntOperationFilterInput	Id da integração Financeira
financialOwner	FinancialOwnerFilterInput	Dados do Responsável Financeiro
financialOwnerId	IntOperationFilterInput	Id do Responsável Financeiro
graphQLRequestLogs	ListFilterInputTypeOfGraphQLRequestLogFilterInput	Logs de requisições GraphQL
id	IntOperationFilterInput	Id do objeto da Requisição
or	[PaymentPlanFilterInput!]	Combinação de filtros OR
parcelQuantity	IntOperationFilterInput	Quantidade de Parcelas
paymentPlanType	PaymentPlanTypeOperationFilterInput	Tipo de Plano de Pagamento
punctualDiscounts	ListFilterInputTypeOfPunctualDiscountFilterInput	Descontos Pontualidade
refId	UuidOperationFilterInput	Id da Referência

Objeto PaymentPlanSortInput

Campo	Tipo	Descrição
active	SortEnumType	Status de Ativação (ascendente ou descendente)
company	CompanySortInput	Dados da Empresa (ordenar por campos da empresa)
companyId	SortEnumType	Id da Empresa (ascendente ou descendente)
costCenter	CostCenterSortInput	Dados do Centro de Custo (ordenar por campos do centro de custo)
costCenterId	SortEnumType	Id do Centro de Custo (ascendente ou descendente)
creationDate	SortEnumType	Data de Criação (ascendente ou descendente)
deleted	SortEnumType	Status de Deleção (ascendente ou descendente)
dependent	DependentSortInput	Dados do Dependente (ordenar por campos do dependente)
dependentId	SortEnumType	Id do Dependente (ascendente ou descendente)
description	SortEnumType	Descrição (ascendente ou descendente)
documentFileUrl	SortEnumType	Url do arquivo pdf das cobranças (ascendente ou descendente)
externalId	SortEnumType	Id Externo (ascendente ou descendente)
financialIntegration	FinancialIntegrationSortInput	Dados da Integração Financeira (ordenar por campos da integração financeira)
financialIntegrationId	SortEnumType	Id da integração Financeira (ascendente ou descendente)
financialOwner	FinancialOwnerSortInput	Dados do Responsável Financeiro (ordenar por campos do responsável financeiro)
financialOwnerId	SortEnumType	Id do Responsável Financeiro (ascendente ou descendente)
id	SortEnumType	Id do objeto da Requisição (ascendente ou descendente)
parcelQuantity	SortEnumType	Quantidade de Parcelas (ascendente ou descendente)
paymentPlanType	SortEnumType	Tipo de Plano de Pagamento (ascendente ou descendente)
refId	SortEnumType	Id da Referência (ascendente ou descendente)

Response

Response

{
    "data": {
        "paymentPlans": {
            "items": [
                {
                    "paymentPlanType": "MONTHLY",
                    "financialOwnerId": 48,
                    "companyId": 1,
                    "costCenterId": 1,
                    "financialIntegrationId": 1,
                    "id": 335,
                    "creationDate": "2024-12-27T19:53:21.804Z",
                    "active": true,
                    "deleted": false,
                    "billings": [
                        {
                            "pixCode": null,
                            "value": 100,
                            "dueDate": "2025-01-15T00:00:00.000Z",
                            "barcode": "32992996200000100000001090000000427276287110",
                            "billingStatus": "AWAITING_REGISTRATION"
                        },
                        {
                            "pixCode": null,
                            "value": 100,
                            "dueDate": "2025-02-15T00:00:00.000Z",
                            "barcode": "32991999300000100000001090000000427376287110",
                            "billingStatus": "AWAITING_REGISTRATION"
                        }
                    ],
                    "financialOwner": {
                        "name": "Responsável Teste",
                        "cpf": "83265959007"
                    }
                }
            ]
        }
    }
}

Result

Campo	Tipo	Descrição
paymentPlans	PaymentPlansCollectionSegment	Coleção de planos de pagamento

Objeto PaymentPlansCollectionSegment

Campo	Tipo	Descrição
items	[PaymentPlan!]	Lista de planos de pagamento
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.